/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.skywalking.library.elasticsearch.requests.search;

import com.google.common.collect.ImmutableMap;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.apache.skywalking.library.elasticsearch.requests.search.aggregation.Aggregation;

/**
 * Represents the criteria when searching documents in ElasticSearch.
 *
 * @see SearchBuilder to build an immutable instance of this class.
 */
@Getter
@RequiredArgsConstructor(access = AccessLevel.PACKAGE)
public final class Search {
    private final Integer from;
    private final Integer size;
    private final Query query;
    private final Sorts sort;
    private final ImmutableMap<String, Aggregation> aggregations;

    public static SearchBuilder builder() {
        return new SearchBuilder();
    }
}
